logo
API docs by Redocly

Inventory Management Service (2.13)

Download OpenAPI specification:Download

Inventory Management Service Concepts

Abstract

The primary purpose of the Inventory Management Service is to provide the ability to create, view and manage equipment inventories.

Customer Summary

Search Customer Summary

Provides the ability to search for customers with services that allow equipment assignments.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : CustomerID, ServicesAllowingEquipmentAssignmentCount, ServicesWithEquipmentAssignmentCount
  • Sortable : CustomerID, ServicesAllowingEquipmentAssignmentCount, ServicesWithEquipmentAssignmentCount
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Equipment

Search Equipment

Provides the ability to search for equipment.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : AttributePropertyDisplay, AttributePropertyID, AvailableDate, Cost, CreateDate, CreateUserID, EquipmentDataSourceID, EquipmentID, EquipmentOwnerID, EquipmentTypeID, InventoryID, InventoryItemStatusID, LastModified, LastModifiedUserID, Name, ReferenceNumber, ServiceAddressID, StatusChangeDate, WireCenterID
  • Sortable : AttributePropertyDisplay, AttributePropertyID, AvailableDate, Cost, CreateDate, CreateUserID, EquipmentDataSourceID, EquipmentID, EquipmentOwnerID, EquipmentTypeID, InventoryID, InventoryItemStatusID, LastModified, LastModifiedUserID, Name, ReferenceNumber, ServiceAddressID, StatusChangeDate, WireCenterID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Create Equipment

Creates new equipment.

Request Body schema: application/json
AvailableDate
string <datetime>

Date the equipment is available to be used.

Cost
number <float>

Cost associated to the equipment.

EquipmentDataSourceID
integer <int32>

Identity key for the assigned EquipmentDataSource.

EquipmentOwnerID
integer <int32>

ID for the owner of the equipment.

EquipmentTypeID
required
integer <int32>

Identity key for equipment type.

InventoryID
required
integer <int32>

Identity of the Inventory the instance is assigned to.

InventoryItemStatusID
required
integer <int32>

Identity for the current equipment status.

Name
required
string <string>

Name of the equipment instance.

ReferenceNumber
string <string>

Reference Number for the equipment instance.

ServiceAddressID
integer <int32>

Identifier to assigned service address.

StatusChangeDate
required
string <datetime>

Date and time the status of this equipment was changed.

WireCenterID
required
integer <int32>

Unique identifier for the Wire Center.

Responses

Request samples

Content type
application/json
{
  • "AvailableDate": "2008-10-27T16:03:36.443-04:00",
  • "Cost": 1,
  • "EquipmentDataSourceID": 1,
  • "EquipmentOwnerID": 1,
  • "EquipmentTypeID": 1,
  • "InventoryID": 1,
  • "InventoryItemStatusID": 1,
  • "Name": "equip001",
  • "ReferenceNumber": "400002911",
  • "ServiceAddressID": 1,
  • "StatusChangeDate": "2008-10-27T16:03:36.443-04:00",
  • "WireCenterID": 1
}

Response samples

Content type
application/json
{
  • "AttributePropertyDisplay": "AttrProp",
  • "AttributePropertyID": 1,
  • "AvailableDate": "2008-10-27T16:03:36.443-04:00",
  • "Cost": 1,
  • "CreateDate": "2008-10-27T16:03:36.443-04:00",
  • "CreateUserID": 1,
  • "EquipmentID": 1,
  • "EquipmentDataSourceID": 1,
  • "EquipmentOwnerID": 1,
  • "EquipmentTypeID": 1,
  • "InventoryID": 1,
  • "InventoryItemStatusID": 1,
  • "LastModified": "2008-10-27T16:03:36.443-04:00",
  • "LastModifiedUserID": "user1",
  • "Name": "equip001",
  • "ReferenceNumber": "400002911",
  • "ServiceAddressID": 1,
  • "StatusChangeDate": "2008-10-27T16:03:36.443-04:00",
  • "WireCenterID": 1
}

Delete Equipment

Provides the ability to delete the equipment identified by EquipmentID.

path Parameters
EquipmentID
required
any
Example: 1

ID of the Equipment that is to be deleted.

Responses

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Update Equipment

Provides the ability to update the equipment identified by EquipmentID.

path Parameters
EquipmentID
required
any
Example: 1

ID of the Equipment that is to be updated.

Request Body schema: application/json
AvailableDate
string <datetime>

Date the equipment is available to be used.

Cost
number <float>

Cost associated to the equipment.

EquipmentDataSourceID
integer <int32>

Identity key for the assigned EquipmentDataSource.

EquipmentOwnerID
integer <int32>

ID for the owner of the equipment.

EquipmentTypeID
integer <int32>

Identity key for equipment type.

InventoryID
integer <int32>

Identity of the Inventory the instance is assigned to.

InventoryItemStatusID
integer <int32>

Identity for the current equipment status.

Name
string <string>

Name of the equipment instance.

ReferenceNumber
string <string>

Reference Number for the equipment instance.

ServiceAddressID
integer <int32>

Identifier to assigned service address.

StatusChangeDate
string <datetime>

Date and time the status of this equipment was changed.

WireCenterID
integer <int32>

Unique identifier for the Wire Center.

Responses

Request samples

Content type
application/json
{
  • "AvailableDate": "2008-10-27T16:03:36.443-04:00",
  • "Cost": 1,
  • "EquipmentDataSourceID": 1,
  • "EquipmentOwnerID": 1,
  • "EquipmentTypeID": 1,
  • "InventoryID": 1,
  • "InventoryItemStatusID": 1,
  • "Name": "equip001",
  • "ReferenceNumber": "400002911",
  • "ServiceAddressID": 1,
  • "StatusChangeDate": "2008-10-27T16:03:36.443-04:00",
  • "WireCenterID": 1
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Create Equipment Range

Provides the ability to create a range of new equipment. The equipment name will have the range value appended to the end.

Request Body schema: application/json
AvailableDate
string <datetime>

Date the equipment is available to be used.

Cost
number <float>

Cost associated to the equipment.

EquipmentDataSourceID
integer <int32>

Identity key for the assigned EquipmentDataSource.

EquipmentOwnerID
integer <int32>

ID for the owner of the equipment.

EquipmentTypeID
required
integer <int32>

Identity key for equipment type.

InventoryID
required
integer <int32>

Identity of the Inventory the instance is assigned to.

InventoryItemStatusID
required
integer <int32>

Identity for the current equipment status.

Name
required
string <string>

Name of the equipment instance.

ReferenceNumber
string <string>

Reference Number for the equipment instance.

ServiceAddressID
integer <int32>

Identifier to assigned service address.

StatusChangeDate
required
string <datetime>

Date and time the status of this equipment was changed.

WireCenterID
required
integer <int32>

Unique identifier for the Wire Center.

RangeFrom
required
integer <int32>

Starting value for the equipment range.

RangeTo
required
integer <int32>

Ending value for the equipment range.

Responses

Request samples

Content type
application/json
{
  • "AvailableDate": "2008-10-27T16:03:36.443-04:00",
  • "Cost": 1,
  • "EquipmentDataSourceID": 1,
  • "EquipmentOwnerID": 1,
  • "EquipmentTypeID": 1,
  • "InventoryID": 1,
  • "InventoryItemStatusID": 1,
  • "Name": "equip001",
  • "ReferenceNumber": "400002911",
  • "ServiceAddressID": 1,
  • "StatusChangeDate": "2008-10-27T16:03:36.443-04:00",
  • "WireCenterID": 1,
  • "RangeFrom": 1,
  • "RangeTo": 10
}

Response samples

Content type
application/json
[
  • 1
]

Equipment Assignment

Search Equipment Assignment

Provides the ability to search for equipment assignments.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : EquipmentAssignmentID, EquipmentAssignmentTemplateID, ServiceID
  • Sortable : EquipmentAssignmentID, EquipmentAssignmentTemplateID, ServiceID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Create Equipment Assignment

Creates a new equipment assignment.

Request Body schema: application/json
EquipmentAssignmentTemplateID
integer <int32>

Unique identifier for the template of the equipment assignment.

ServiceID
required
integer <int32>

Unique identifier for the service of the equipment assignment.

Responses

Request samples

Content type
application/json
{
  • "EquipmentAssignmentTemplateID": 2,
  • "ServiceID": 4
}

Response samples

Content type
application/json
{
  • "EquipmentAssignmentID": 3,
  • "EquipmentAssignmentTemplateID": 2,
  • "ServiceID": 4
}

Update Equipment Assignment

Provides the ability to update the equipment assignment identified by EquipmentAssignmentID.

path Parameters
EquipmentAssignmentID
required
any
Example: 1

ID of the equipment assignment that is to be updated.

Request Body schema: application/json
EquipmentAssignmentTemplateID
integer <int32>

Unique identifier for the template of the equipment assignment.

Responses

Request samples

Content type
application/json
{
  • "EquipmentAssignmentTemplateID": 2
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Equipment Assignment Method

Search Equipment Assignment Method

Provides the ability to search for equipment assignment methods.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : Description, EquipmentAssignmentMethodID
  • Sortable : Description, EquipmentAssignmentMethodID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Equipment Assignment Service Address

Search Equipment Assignment Service Address

Provides the ability to search for equipment assignment service addresses.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : EquipmentAssignmentID, EquipmentID, ServiceAddressID, ServiceID
  • Sortable : EquipmentAssignmentID, EquipmentID, ServiceAddressID, ServiceID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Equipment Assignment Summary

Search Equipment Assignment Summary

Provides the ability to search for summary information about equipment assignment.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : CustomerID, EquipmentAssignmentID, EquipmentCount, LocationCount, ServiceID
  • Sortable : CustomerID, EquipmentAssignmentID, EquipmentCount, LocationCount, ServiceID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Equipment Assignment Template

Search Equipment Assignment Template

Provides the ability to search for equipment assignment templates.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : AllowLocationDescription, Description, EquipmentAssignmentTemplateID, Inventory, InventoryID
  • Sortable : AllowLocationDescription, Description, EquipmentAssignmentTemplateID, Inventory, InventoryID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Equipment Customer Overview

Search Equipment Customer Overview

Provides the ability to search for equipment associated to customers in the system. [Rev 1.01]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : CustomerID, EquipmentID, ServiceAddressCount, ServiceCount
  • Sortable : CustomerID, EquipmentID, ServiceAddressCount, ServiceCount
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Equipment Data Source

Search Equipment Data Source

Provides the ability to search for equipment data sources in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : Description, EquipmentDataSourceID
  • Sortable : Description, EquipmentDataSourceID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Equipment History

Search Equipment History

Provides the ability to search for equipment history in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : AvailableDate, ChangeDate, CustomerID, EquipmentHistoryID, EquipmentID, InventoryItemStatusID, StatusChangeDate, User
  • Sortable : AvailableDate, ChangeDate, CustomerID, EquipmentHistoryID, EquipmentID, InventoryItemStatusID, StatusChangeDate, User
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Equipment Owner

Search Equipment Owner

Provides the ability to search for equipment owner in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : Description, EquipmentOwnerID
  • Sortable : Description, EquipmentOwnerID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Equipment Type

Search Equipment Type

A list of all equipment types configured in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : AllowLocation, AllowReassignment, AttributePropertyDisplay, AttributePropertyID, Description, EquipmentAssignmentMethodID, EquipmentTypeID, OpenTicketEquipmentStatusID, ValidateOnAssignment
  • Sortable : AllowLocation, AllowReassignment, AttributePropertyDisplay, AttributePropertyID, Description, EquipmentAssignmentMethodID, EquipmentTypeID, OpenTicketEquipmentStatusID, ValidateOnAssignment
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Create Equipment Type

Creates a new equipment type.

Request Body schema: application/json
AllowLocation
boolean <boolean>

If true, equipment of this type can have a Service Address associated with it. Otherwise, it cannot.

AllowReassignment
boolean <boolean>

If true, equipment of this type can be reassigned. Otherwise, it cannot.

AttributePropertyID
integer <int32>

Unique Identifier for the root property of the attribute definition configured for this equipment type.

Description
required
string <string>

Unique name of the equipment type.

EquipmentAssignmentMethodID
required
integer <int32>

Unique identifier of the equipment assignment method.

OpenTicketEquipmentStatusID
integer <int32>

The status an equipment will be set to if there are open tickets when the equipment is removed from all assignments. [Rev 1.03]

ValidateOnAssignment
boolean <boolean>

If true, equipment of this type will validate attributes if the equipment has a status of assigned, in-use, or left in.

Responses

Request samples

Content type
application/json
{
  • "AllowLocation": true,
  • "AllowReassignment": false,
  • "AttributePropertyID": 1,
  • "Description": "Blade Servers",
  • "EquipmentAssignmentMethodID": 1,
  • "OpenTicketEquipmentStatusID": 1,
  • "ValidateOnAssignment": true
}

Response samples

Content type
application/json
{
  • "AllowLocation": true,
  • "AllowReassignment": false,
  • "AttributePropertyDisplay": "Prop One",
  • "AttributePropertyID": 1,
  • "Description": "Blade Servers",
  • "EquipmentAssignmentMethodID": 1,
  • "EquipmentTypeID": 7,
  • "OpenTicketEquipmentStatusID": 1,
  • "ValidateOnAssignment": true
}

Update Equipment Type

Provides the ability to update the equipment type identified by EquipmentTypeID.

path Parameters
EquipmentTypeID
required
any
Example: 1

ID of the Equipment type that is to be updated.

Request Body schema: application/json
AllowLocation
boolean <boolean>

If true, equipment of this type can have a Service Address associated with it. Otherwise, it cannot.

AllowReassignment
boolean <boolean>

If true, equipment of this type can be reassigned. Otherwise, it cannot.

AttributePropertyID
integer <int32>

Unique Identifier for the root property of the attribute definition configured for this equipment type.

Description
string <string>

Unique name of the equipment type.

Note

Description cannot be null and must be unique.

EquipmentAssignmentMethodID
integer <int32>

Unique identifier of the equipment assignment method.

OpenTicketEquipmentStatusID
integer <int32>

The status an equipment will be set to if there are open tickets when the equipment is removed from all assignments. [Rev 1.03]

ValidateOnAssignment
boolean <boolean>

If true, equipment of this type will validate attributes if the equipment has a status of assigned, in-use, or left in.

Responses

Request samples

Content type
application/json
{
  • "AllowLocation": true,
  • "AllowReassignment": false,
  • "AttributePropertyID": 1,
  • "Description": "Blade Servers",
  • "EquipmentAssignmentMethodID": 1,
  • "OpenTicketEquipmentStatusID": 1,
  • "ValidateOnAssignment": true
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Delete Equipment Type

Provides the ability to delete the equipment type identified by EquipmentTypeID.

path Parameters
EquipmentTypeID
required
any
Example: 1

ID of the Equipment Type that is to be deleted.

Responses

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Equipment Warranty

Search Equipment Warranty

Provides the ability to search for equipment warranties in the system..

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : ActivationDate, EquipmentID, EquipmentWarrantyID, ExpirationDate, ReferenceNumber, TermDuration, WarrantyID
  • Sortable : ActivationDate, EquipmentID, EquipmentWarrantyID, ExpirationDate, ReferenceNumber, TermDuration, WarrantyID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Create Equipment Warranty

Provides the ability to create a new equipment warranty.

Request Body schema: application/json
ActivationDate
required
string <datetime>

Date the equipment warranty is active.

EquipmentID
required
integer <int32>

Unique identifier for the equipment to which the warranty was added.

ExpirationDate
required
string <datetime>

Date the warranty expires.

ReferenceNumber
string <string>

Reference number for the equipment warranty.

TermDuration
required
integer <int32>

Duration of the warranty in months.

WarrantyID
required
integer <int32>

Unique identifier for the warranty.

Responses

Request samples

Content type
application/json
{
  • "ActivationDate": "2008-10-27T16:03:36.443-04:00",
  • "EquipmentID": 3,
  • "ExpirationDate": "2008-10-27T16:03:36.443-04:00",
  • "ReferenceNumber": "A4456-F4-GXh28",
  • "TermDuration": 1,
  • "WarrantyID": 1
}

Response samples

Content type
application/json
{
  • "ActivationDate": "2008-10-27T16:03:36.443-04:00",
  • "EquipmentID": 3,
  • "EquipmentWarrantyID": 1,
  • "ExpirationDate": "2008-10-27T16:03:36.443-04:00",
  • "ReferenceNumber": "A4456-F4-GXh28",
  • "TermDuration": 1,
  • "WarrantyID": 1
}

Update Equipment Warranty

Provides the ability to update the equipment warranty identified by EquipmentWarrantyID.

path Parameters
EquipmentWarrantyID
required
any
Example: 1

ID of the Equipment Warranty that is to be updated.

Request Body schema: application/json
ActivationDate
required
string <datetime>

Date the equipment warranty is active.

ReferenceNumber
string <string>

Reference number for the equipment warranty.

TermDuration
required
integer <int32>

Duration of the warranty in months.

Responses

Request samples

Content type
application/json
{
  • "ActivationDate": "2008-10-27T16:03:36.443-04:00",
  • "ReferenceNumber": "A4456-F4-GXh28",
  • "TermDuration": 1
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Delete Equipment Warranty

Provides the ability to delete the equipment warranty identified by EquipmentWarrantyID.

path Parameters
EquipmentWarrantyID
required
any
Example: 1

ID of the Equipment Warranty that is to be deleted.

Responses

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Extended Information

Modify Extended Information

Provides the ability to modify the extended information that is associated with various types of objects. [Rev 1.04]

Request Body schema: application/json
required
Array of objects (ExtendedInformationItemRequest)

A set of ExtendedInformationItems to associate with the specified object.

ObjectID
required
integer <int32>

Unique identifier of an existing object of the type specified by ObjectTypeID.

ObjectType
required
integer <int32>

The unique identifier for the type of object to which this extended property is associated

Note

  • Equipment Type = 1
  • Equipment = 2

Responses

Request samples

Content type
application/json
{
  • "ExtendedInformationItems": [
    ],
  • "ObjectID": 234,
  • "ObjectType": 1
}

Response samples

Content type
application/json
{
  • "ExtendedInformationItems": [
    ],
  • "ObjectID": 234,
  • "ObjectType": 1
}

Extended Information Item

Search Extend Information Item

A list of additional key/value properties associated with any objects of the types shown.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : Key, ObjectID, ObjectType, ObjectTypeID, Value
  • Sortable : Key, ObjectID, ObjectType, ObjectTypeID, Value
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Inventory

Search Inventory

Provides the ability to search for inventories and lookup values into identifier columns.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : Description, InventoryClass, InventoryClassID, InventoryID
  • Sortable : Description, InventoryClass, InventoryClassID, InventoryID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Location

Search Location

Provides the ability to search for locations.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : EquipmentAssignmentID, LocationDescriptionID, LocationID, LocationStatusID, PendingLocationStatusID, ServiceAddressID
  • Sortable : EquipmentAssignmentID, LocationDescriptionID, LocationID, LocationStatusID, PendingLocationStatusID, ServiceAddressID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Create Location

Provides the ability to create a location

Request Body schema: application/json
EquipmentAssignmentID
integer <int32>

Unique identifier for the equipment assignment that this location is associated to.

LocationDescriptionID
integer <int32>

Unique identifier for the location description of the location.

LocationStatusID
required
integer <int32>

Unique identifier for the location status of the location.

ServiceAddressID
required
integer <int32>

Unique identifier for the service address.

Responses

Request samples

Content type
application/json
{
  • "EquipmentAssignmentID": 1,
  • "LocationDescriptionID": 1,
  • "LocationStatusID": 1,
  • "ServiceAddressID": 1
}

Response samples

Content type
application/json
{
  • "EquipmentAssignmentID": 1,
  • "LocationDescriptionID": 1,
  • "LocationID": 1,
  • "LocationStatusID": 1,
  • "PendingLocationStatusID": 1,
  • "ServiceAddressID": 1
}

Update Location

Provides the ability to update the location identified by LocationID. If the location is associated to a service who's service type is configured for two phase commit, any change to the location status will be stored in PendingLocationStatusID untill the change is committed.

path Parameters
LocationID
required
any
Example: 1

ID of the Location that is to be updated.

Request Body schema: application/json
EquipmentAssignmentID
integer <int32>

Unique identifier for the equipment assignment that this location is associated to.

LocationDescriptionID
integer <int32>

Unique identifier for the location description of the location.

LocationStatusID
integer <int32>

Unique identifier for the location status of the location.

Note

Setting the status to ID 1(Inactive) will cause the location to be deleted.

ServiceAddressID
integer <int32>

Unique identifier for the service address.

Note

Service Address on the location must match a service address of the service associated to the equipment assignment ID.

Responses

Request samples

Content type
application/json
{
  • "EquipmentAssignmentID": 1,
  • "LocationDescriptionID": 1,
  • "LocationStatusID": 1,
  • "ServiceAddressID": 1
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Left-In Location

Search Left-In Location

Provides the ability to search for left-in locations.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : LocationDescriptionID, LocationID, LocationStatusID, PendingLocationStatusID, ServiceAddressID, ServiceID
  • Sortable : LocationDescriptionID, LocationID, LocationStatusID, PendingLocationStatusID, ServiceAddressID, ServiceID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Location Equipment

Search Location Equipment

Provides the ability to search for equipment at locations.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : EquipmentID, LocationEquipmentID, LocationID, PendingInventoryItemStatusID
  • Sortable : EquipmentID, LocationEquipmentID, LocationID, PendingInventoryItemStatusID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Add Equipment to Location

Provides the ability to add equipment to a location ### Note: Equipment can be added to a locatin if:

Equipment Type Assignment Method Equipment Status Location Status
Single Customer Available Active
Single Customer Available Active (Changes Pending)
Multiple Customer Available Active
Multiple Customer Reserved Active
Multiple Customer Assigned Active
Multiple Customer Assigned (In-Use) Active
Multiple Customer Avaliable Active (Changes Pending)
Multiple Customer Reserved Active (Changes Pending)
Multiple Customer Assigned Active (Changes Pending)
Multiple Customer Assigned (In-Use) Active (Changes Pending)
Request Body schema: application/json
EquipmentID
integer <int32>

Unique identifier for the equipment.

LocationID
integer <int32>

Unique identifier for the location.

Responses

Request samples

Content type
application/json
{
  • "EquipmentID": 1,
  • "LocationID": 1
}

Response samples

Content type
application/json
{
  • "EquipmentID": 1,
  • "LocationEquipmentID": 1,
  • "LocationID": 1,
  • "PendingInventoryItemStatusID": 1
}

Delete Location Equipment

Provides the ability to delete the equipment association from a location identified by LocationEquipmentID.

path Parameters
LocationEquipmentID
required
any
Example: 1

ID of the LocationEquipment that is to be deleted.

Responses

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Location Description

Search Location Descriptions

Provides the ability to search for location descriptions in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : LocationDescriptionID, Name
  • Sortable : LocationDescriptionID, Name
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Location Status

Search Location Status

Provides the ability to search for location statuses in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : Description, LocationStatusID
  • Sortable : Description, LocationStatusID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Service Order Detail

Search Service Order Detail

Provides the ability to search for billing orders containing services that allow equipment assignments.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : BillingOrderDetailID, BillingOrderDetailType, BillingOrderDetailTypeID, BillingOrderID, CustomerID, EquipmentAssignmentID, ServiceID
  • Sortable : BillingOrderDetailID, BillingOrderDetailType, BillingOrderDetailTypeID, BillingOrderID, CustomerID, EquipmentAssignmentID, ServiceID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Service Order Summary

Search Service Order Summary

Provides the ability to search for billing orders containing services that allow equipment assignments.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : BillingOrderID, CompleteDate, CreateDate, CustomerID, Description, OrderType, OrderTypeID, OriginatingCartID, ServicesAllowingEquipmentAssignmentCount, ServicesWithEquipmentAssignmentCount, Status, StatusID
  • Sortable : BillingOrderID, CompleteDate, CreateDate, CustomerID, Description, OrderType, OrderTypeID, OriginatingCartID, ServicesAllowingEquipmentAssignmentCount, ServicesWithEquipmentAssignmentCount, Status, StatusID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Warranty

Search Warranties

Provides the ability to search for warranties in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : Description, EndDate, Name, StartDate, TermDuration, WarrantyID, WarrantyTypeID
  • Sortable : Description, EndDate, Name, StartDate, TermDuration, WarrantyID, WarrantyTypeID
query Parameters
$count
number
Example: $count=3
  • Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
$expand
string
Example: $expand=EquipmentTypeLink
  • A list of comma-seperated properies to expand into when returning the result.
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "value": [
    ],
  • "@odata.nextLink": "https://api.idibilling.com/inventorymanagement/{ennvironment}/api/odataquery?$filter=field1 eq 5"
}

Release Notes

Release Notes 2.13

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.11

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.10

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.09

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.08

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.06

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.05

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.04

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.03

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.02

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.01

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.00

  • Note: Major version change was for internal changes only and not a breaking change.

Release Notes 1.23

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.22

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.21

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.20

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.19

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.18

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.17

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.16

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.15

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.14

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.13

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.12

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.11

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.10

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.09

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.08

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.07

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.06

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.05

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.04

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.03

  • Added ability to set 'OpenTicketEquipmentStatusID' when creating equipment types.
  • Added ability to set 'OpenTicketEquipmentStatusID' when updating equipment types.
  • Added 'OpenTicketEquipmentStatusID' to the result when searching equipment types.
  • Added the ability to expand into 'InventoryItemStatus' when searching equipment types.
  • Added the ability to expand into 'EquipmentTicketSummary' when searching equipment.

Release Notes 1.02.01

Release Notes 1.02

.01

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.02

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.01

  • Added capability to search for equipment assignement service addresses in the system.
  • Added capability to search for equipment associated to customers in the system.
  • Added validation for duplicate equipment by inventory, equipment name, equipment type, and wire center when creating equipment.
    • Note: Without this validation, it was possible to create Equipment in the same Inventory with the same Equipment Name, Equipment Type, and Wire Center. This is no longer allowed.

Release Notes 1.00

  • Initial Release of Inventory Management API